Skip to content

docs: correct literal argument output examples - #254

Open
Likio3000 wants to merge 1 commit into
gruns:masterfrom
Likio3000:docs/correct-literal-output-examples-20260923
Open

Likio3000 wants to merge 1 commit into
gruns:masterfrom
Likio3000:docs/correct-literal-output-examples-20260923

Conversation

@Likio3000

Copy link
Copy Markdown

Several README examples repeat a literal argument before its value (ic| 1: 1), although IceCream suppresses literal labels in short, single-line output. This corrects the enable/disable, callable-prefix, logging, and custom-formatter examples and explains the difference between literal and variable arguments.

Validation: traced isLiteral() and _constructArgumentOutput() in the current source and checked the existing test_nested_multiline, test_output_function, test_enable_disable, and test_arg_to_string_function assertions. The custom formatter still transforms values before literal labels are omitted. This is a README-only change; I did not install dependencies or run the project test suite locally.

AI assistance: prepared with OpenAI Codex and reviewed against the repository's implementation and existing tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant